<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Directory and File Structure</title>
<link rel="stylesheet" href="../math.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../index.html" title="Math Toolkit 4.2.1">
<link rel="up" href="../overview.html" title="Chapter 1. Overview">
<link rel="prev" href="hints.html" title="Other Hints and tips">
<link rel="next" href="namespaces.html" title="Namespaces">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center"><a href="../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="hints.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="namespaces.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="math_toolkit.directories"></a><a class="link" href="directories.html" title="Directory and File Structure">Directory and File Structure</a>
</h2></div></div></div>
<h5>
<a name="math_toolkit.directories.h0"></a>
      <span class="phrase"><a name="math_toolkit.directories.boost_math"></a></span><a class="link" href="directories.html#math_toolkit.directories.boost_math">boost/math</a>
    </h5>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">/concepts/</span></dt>
<dd><p>
            Prototype defining the <span class="bold"><strong>essential</strong></span> features
            of a RealType class (see real_concept.hpp). Most applications will use
            <code class="computeroutput"><span class="keyword">double</span></code> as the RealType (and
            short <code class="computeroutput"><span class="keyword">typedef</span></code> names of distributions
            are reserved for this type where possible), a few will use <code class="computeroutput"><span class="keyword">float</span></code> or <code class="computeroutput"><span class="keyword">long</span>
            <span class="keyword">double</span></code>, but it is also possible
            to use higher precision types like <a href="http://shoup.net/ntl/doc/RR.txt" target="_top">NTL::RR</a>,
            <a href="http://gmplib.org/" target="_top">GNU Multiple Precision Arithmetic Library</a>,
            <a href="http://www.mpfr.org/" target="_top">GNU MPFR library</a>, <a href="../../../../../libs/multiprecision/doc/html/index.html" target="_top">Boost.Multiprecision</a>
            like cpp_bin_float_50 that conform to the requirements specified by
            <code class="computeroutput"><span class="identifier">real_concept</span></code>.
          </p></dd>
<dt><span class="term">/constants/</span></dt>
<dd><p>
            Templated definition of some highly accurate math constants (<a href="https://github.com/boostorg/math/blob/develop/include/boost/math/constants/constants.hpp" target="_top">constants.hpp</a>).
          </p></dd>
<dt><span class="term">/distributions/</span></dt>
<dd><p>
            Distributions used in mathematics and, especially, statistics: Gaussian,
            Students-t, Fisher, Binomial etc
          </p></dd>
<dt><span class="term">/policies/</span></dt>
<dd><p>
            Policy framework, for handling user requested behaviour modifications.
          </p></dd>
<dt><span class="term">/special_functions/</span></dt>
<dd><p>
            Math functions generally regarded as 'special', like beta, cbrt, erf,
            gamma, lgamma, tgamma ... (Some of these are specified in C++, and C99/TR1,
            and perhaps TR2).
          </p></dd>
<dt><span class="term">/tools/</span></dt>
<dd><p>
            Tools used by functions, like evaluating polynomials, continued fractions,
            root finding, precision and limits, and by tests. Some will find application
            outside this package.
          </p></dd>
</dl>
</div>
<h5>
<a name="math_toolkit.directories.h1"></a>
      <span class="phrase"><a name="math_toolkit.directories.boost_libs"></a></span><a class="link" href="directories.html#math_toolkit.directories.boost_libs">boost/libs</a>
    </h5>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">/doc/</span></dt>
<dd><p>
            Documentation source files in Quickbook format processed into html and
            pdf formats.
          </p></dd>
<dt><span class="term">/examples/</span></dt>
<dd><p>
            Examples and demos of using math functions and distributions.
          </p></dd>
<dt><span class="term">/performance/</span></dt>
<dd><p>
            Performance testing and tuning program.
          </p></dd>
<dt><span class="term">/test/</span></dt>
<dd><p>
            Test files, in many .cpp files, most using Boost.Test (some with test
            data as .ipp files, usually generated using NTL RR type with ample precision
            for the type, often for precisions suitable for up to 256-bit significand
            real types).
          </p></dd>
<dt><span class="term">/tools/</span></dt>
<dd><p>
            Programs used to generate test data. Also changes to the <a href="http://shoup.net/ntl/" target="_top">NTL</a>
            released package to provide a few additional (and vital) extra features.
          </p></dd>
</dl>
</div>
</div>
<div class="copyright-footer">Copyright © 2006-2021 Nikhar Agrawal, Anton Bikineev, Matthew Borland,
      Paul A. Bristow, Marco Guazzone, Christopher Kormanyos, Hubert Holin, Bruno
      Lalande, John Maddock, Evan Miller, Jeremy Murphy, Matthew Pulver, Johan Råde,
      Gautam Sewani, Benjamin Sobotta, Nicholas Thompson, Thijs van den Berg, Daryle
      Walker and Xiaogang Zhang<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="hints.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="namespaces.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
